lemon.external.epydoc.objdoc.PropertyDoc

Package lemon :: Package external :: Package epydoc :: Module objdoc :: Class PropertyDoc

[show private | hide private]

Class PropertyDoc

ObjDoc --+
         |
        PropertyDoc

The documentation for a property. This documentation consists of standard pieces of documentation (as defined in ObjDoc), and the following property-specific pieces of documentation:

fget: The property's get function
fset: The property's set function
fdel: The property's delete function
type: The property's type

Method Summary
	`__init__(self, uid, typ, verbosity)`
	`__repr__(self)`
	`_process_field(self, tag, arg, descr, warnings)` Process a field from this object's docstring.
Accessors
`UID`	`fdel(self)` Return the UID of this property's delete function.
`UID`	`fget(self)` Return the UID of this property's get function.
`UID`	`fset(self)` Return the UID of this property's set function.
`markup.ParsedDocstring`	`type(self)` Return a description of this property's type.
Inherited from ObjDoc
`list` of `(string, elt)`	`by_group(self, elts)` Divide a set of elements into groups.
`boolean`	`defines_groups(self)` Return true if the object documented by this `ObjDoc` defines any groups.
`markup.ParsedDocstring`	`descr(self)` Return a description of the object documented by this `ObjDoc`.
`list` of `markup.ParsedDocstring`	`field_values(self, field)` Return a list of the values that are specified for the given field in the docstring of the object documented by this `ObjDoc`.
`list` of `DocField`	`fields(self)` Return a list of the fields that are given values in the docstring of the object documented by this `ObjDoc`.
`list` of `string`	`groups(self)` Return a list of the names of the groups that are defined for the object documented by this `ObjDoc`.
`boolean`	`has_docstring(self)` Return true if the object documented by this `ObjDoc` has a docstring.
`list` of `string`	`sortorder(self)` Return a list specifying the sort order that should be used for the object's children.
`markup.ParsedDocstring`	`summary(self)` Return a summary of the description of the object documented by this `ObjDoc`.
`UID`	`uid(self)` Return the UID of the object documented by this `ObjDoc`.
`None`	`_print_errors(self, stream)` Print any errors that were encountered while constructing this `ObjDoc` to `stream`.
	`_sort(self, items)` Return a copy of the list `items`, sorted first by `sortorder`, and then by name.

Instance Variable Summary
Inherited from ObjDoc
`markup.ParsedDocstring`	`_descr`: The object's description, encoded as epytext.
	`_field_warnings`: Warnings generated when processing the object's docstring's fields.
`dictionary` from `DocField` to `list` of `markup.ParsedDocstring`	`_fields`: Documentation fields that were extracted from the object's docstring.
	`_misc_warnings`: Warnings that are not related to the object's docstring.
	`_parse_errors`: Errors generated when parsing the object's docstring.
	`_parse_warnings`: Warnings generated when parsing the object's docstring.
`UID`	`_uid`: The object's unique identifier

Class Variable Summary
Inherited from ObjDoc
`List` of `DocField`	`STANDARD_FIELDS`: The list of standard docstring fields that epydoc accepts.

Method Details

fdel(self)

Returns:: The UID of this property's delete function.
(type=UID)

fget(self)

Returns:: The UID of this property's get function.
(type=UID)

fset(self)

Returns:: The UID of this property's set function.
(type=UID)

type(self)

Returns:: A description of this property's type.
(type=markup.ParsedDocstring)

_process_field(self, tag, arg, descr, warnings)

Process a field from this object's docstring. ObjDoc._process_field be overridden by child classes of ObjDoc, and called as the default case.

Parameters:: tag - The field's tag name
(type=string); arg - The field's optional argument (or None if no argument was specified).
(type=string); descr - The field's body.
(type=markup.ParsedDocstring); warnings - A list of warnings that have been encountered. If any new warnings are encountered, then they should be appended to this list.

Overrides:: lemon.external.epydoc.objdoc.ObjDoc._process_field (inherited documentation)

Generated by Epydoc 2.0 on Mon Nov 10 15:08:08 2003

http://epydoc.sf.net